<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: MoBANLocal Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00143.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">MoBANLocal Class Reference<div class="ingroups"><a class="el" href="a00513.html">mobility - modules handling the mobility of the hosts</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="MoBANLocal" --><!-- doxytag: inherits="LineSegmentsMobilityBase" -->
<p>This is the local mobility module of MoBAN. It should be instantiated in each node that belongs to a WBAN. The NED parameter "coordinatorIndex" determines to which WBAN (<a class="el" href="a00142.html" title="This is the coordinator module of the MoBAN mobility model. It should be instantiated in the top leve...">MoBANCoordinator</a>) it belongs. The current implementation uses the Random Walk Mobility Model (RWMM) for individual (local) movement within a sphere around the node, with given speed and sphere radius of the current posture. The reference point of the node in the current posture, the sphere radius, and the speed is given by the corresponding coordinator. RWMM determines the location of the node at any time relative to the given reference point.  
 <a href="a00143.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00359_source.html">MoBANLocal.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for MoBANLocal:</div>
<div class="dyncontent">
<div class="center"><img src="a00872.png" border="0" usemap="#MoBANLocal_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for MoBANLocal:</div>
<div class="dyncontent">
<div class="center"><img src="a00873.png" border="0" usemap="#MoBANLocal_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00874.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9148fd6e18f5265af270b1216438d699"></a><!-- doxytag: member="MoBANLocal::getCurrentPosition" ref="a9148fd6e18f5265af270b1216438d699" args="()" -->
virtual <a class="el" href="a00065.html">Coord</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a9148fd6e18f5265af270b1216438d699">getCurrentPosition</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current position at the current simulation time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cbbd068df6b5cb5ca7b610cfc2a89a5"></a><!-- doxytag: member="MoBANLocal::getCurrentSpeed" ref="a7cbbd068df6b5cb5ca7b610cfc2a89a5" args="()" -->
virtual <a class="el" href="a00065.html">Coord</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a7cbbd068df6b5cb5ca7b610cfc2a89a5">getCurrentSpeed</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current speed at the current simulation time. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affd820423e296cde74eaf99a774b77d5"></a><!-- doxytag: member="MoBANLocal::setCoordinator" ref="affd820423e296cde74eaf99a774b77d5" args="(MoBANCoordinator *coordinator)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setCoordinator</b> (<a class="el" href="a00142.html">MoBANCoordinator</a> *<a class="el" href="a00143.html#a27d8b3ee6c3e979dc41598a9f6884987">coordinator</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f9692b956f5685832ef4ce88acd0aaf"></a><!-- doxytag: member="MoBANLocal::setMoBANParameters" ref="a3f9692b956f5685832ef4ce88acd0aaf" args="(Coord referencePoint, double radius, double speed)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>setMoBANParameters</b> (<a class="el" href="a00065.html">Coord</a> referencePoint, double <a class="el" href="a00143.html#ad7c99333da43a55b3c6655a06fc9a325">radius</a>, double <a class="el" href="a00143.html#a4b7f222408bca8188bb9a362d4eeff9f">speed</a>)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2838f6184efad9d12ec25e6d46494aea"></a><!-- doxytag: member="MoBANLocal::initialize" ref="a2838f6184efad9d12ec25e6d46494aea" args="(int)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a2838f6184efad9d12ec25e6d46494aea">initialize</a> (int)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes mobility model parameters. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93e6176d211370793fbc484843de19cb"></a><!-- doxytag: member="MoBANLocal::initializePosition" ref="a93e6176d211370793fbc484843de19cb" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a93e6176d211370793fbc484843de19cb">initializePosition</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the position from the display string or from module parameters. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a181399edf633b6598fad60cf2fbce7"></a><!-- doxytag: member="MoBANLocal::setTargetPosition" ref="a7a181399edf633b6598fad60cf2fbce7" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a7a181399edf633b6598fad60cf2fbce7">setTargetPosition</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Should be redefined in subclasses. This method gets called when targetPosition and nextChange has been reached, and its task is to set a new targetPosition and nextChange. At the end of the movement sequence, it should set nextChange to -1. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe9bd0c64b94704767ce8396f86383fa"></a><!-- doxytag: member="MoBANLocal::updateVisualRepresentation" ref="abe9bd0c64b94704767ce8396f86383fa" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#abe9bd0c64b94704767ce8396f86383fa">updateVisualRepresentation</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Moves the visual representation module's icon to the new position on the screen. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27d8b3ee6c3e979dc41598a9f6884987"></a><!-- doxytag: member="MoBANLocal::coordinator" ref="a27d8b3ee6c3e979dc41598a9f6884987" args="" -->
<a class="el" href="a00142.html">MoBANCoordinator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a27d8b3ee6c3e979dc41598a9f6884987">coordinator</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The coordinator of the WBAN. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4392ee7a05242ea5317675c1ed149796"></a><!-- doxytag: member="MoBANLocal::referencePosition" ref="a4392ee7a05242ea5317675c1ed149796" args="" -->
<a class="el" href="a00065.html">Coord</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a4392ee7a05242ea5317675c1ed149796">referencePosition</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reference position of the node in the current posture. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7c99333da43a55b3c6655a06fc9a325"></a><!-- doxytag: member="MoBANLocal::radius" ref="ad7c99333da43a55b3c6655a06fc9a325" args="" -->
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#ad7c99333da43a55b3c6655a06fc9a325">radius</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The radius of local mobility of the node in the current posture. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b7f222408bca8188bb9a362d4eeff9f"></a><!-- doxytag: member="MoBANLocal::speed" ref="a4b7f222408bca8188bb9a362d4eeff9f" args="" -->
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00143.html#a4b7f222408bca8188bb9a362d4eeff9f">speed</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The speed of local mobility of the node in the current posture. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This is the local mobility module of MoBAN. It should be instantiated in each node that belongs to a WBAN. The NED parameter "coordinatorIndex" determines to which WBAN (<a class="el" href="a00142.html" title="This is the coordinator module of the MoBAN mobility model. It should be instantiated in the top leve...">MoBANCoordinator</a>) it belongs. The current implementation uses the Random Walk Mobility Model (RWMM) for individual (local) movement within a sphere around the node, with given speed and sphere radius of the current posture. The reference point of the node in the current posture, the sphere radius, and the speed is given by the corresponding coordinator. RWMM determines the location of the node at any time relative to the given reference point. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Majid Nabi </dd></dl>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/inet_stub/mobility/models/<a class="el" href="a00359_source.html">MoBANLocal.h</a></li>
<li>D:/Projects/MiXiM/extsrc/mixim/src/inet_stub/mobility/models/MoBANLocal.cc</li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00143.html">MoBANLocal</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:32 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
